Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

migration guide: add section for documenting cylc8 changes #241

Merged
merged 3 commits into from
May 2, 2021
Merged

migration guide: add section for documenting cylc8 changes #241

merged 3 commits into from
May 2, 2021

Conversation

oliver-sanders
Copy link
Member

@oliver-sanders oliver-sanders commented Apr 27, 2021 •
edited
Loading

Addresses #170

  • move cylc 8 change overview into this section
  • add a cheat sheet containing highlighted cli changes
  • create a space for the "migration guide"
  • write the first guide on suicide triggers to get the ball rolling

@oliver-sanders oliver-sanders self-assigned this Apr 27, 2021
@oliver-sanders oliver-sanders mentioned this pull request Apr 27, 2021
Closed
20 tasks
@oliver-sanders oliver-sanders requested a review from hjoliver April 27, 2021 10:52
@oliver-sanders oliver-sanders added the content Addition or modification of documentation label Apr 27, 2021
hjoliver
hjoliver reviewed Apr 27, 2021
View reviewed changes
src/7-to-8/major-changes/suicide-triggers.rst
Comment on lines +84 to +88
- # Remove the "recover" task in the success case.
- bar => ! recover

- # Remove the "bar" task in the fail case.
- recover => ! bar
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It might be better to just remove theses lines and show the simplified graph in full, rather than using diff format?

hjoliver
hjoliver reviewed Apr 27, 2021
View reviewed changes
Copy link
Member

@hjoliver hjoliver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good structure, just few comments on typos etc.

@oliver-sanders
Copy link
Member Author

Added another page documenting the main things we haven't yet done (essentially this list).

hjoliver
hjoliver approved these changes Apr 28, 2021
View reviewed changes
Copy link
Member

@hjoliver hjoliver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple of minor suggestions

src/7-to-8/caveats.rst Show resolved Hide resolved
src/7-to-8/caveats.rst Show resolved Hide resolved
src/7-to-8/caveats.rst Show resolved Hide resolved
@hjoliver
Copy link
Member

@oliver-sanders I've built a small change on top of this branch, as PR to your fork: oliver-sanders#3

oliver-sanders and others added 3 commits April 30, 2021 10:09
@oliver-sanders
migration guide: add section for documenting cylc8 changes
78578d3 
* move cylc 8 change overview into this section
* add a cheat sheet containing highlighted cli changes
* create a space for the "migration guide"
* write the first guide on suicide triggers
@oliver-sanders @hjoliver
Apply suggestions from code review
ebcb2ab 
Co-authored-by: Hilary James Oliver <hilary.j.oliver@gmail.com>
@oliver-sanders
migration guide: document 8.0b* caveats
b462602
@hjoliver hjoliver merged commit 5cf269a into cylc:master May 2, 2021
@oliver-sanders oliver-sanders deleted the migration-guide branch May 4, 2021 08:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hjoliver hjoliver hjoliver approved these changes

Assignees

@oliver-sanders oliver-sanders

Labels
content Addition or modification of documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@oliver-sanders @hjoliver